﻿// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

namespace osu.Framework.Graphics.Containers
{
    /// <summary>
    /// Implementing this interface in a <see cref="Drawable"/> allows it to be filtered basing on provided search terms
    /// when placed inside a <see cref="SearchContainer{T}"/>.
    /// </summary>
    public interface IFilterable : IHasFilterTerms
    {
        /// <summary>
        /// Whether the current object is matching (ie. visible) given the current filter criteria of a parent.
        /// </summary>
        bool MatchingFilter { set; }

        /// <summary>
        /// Whether a filter is currently being performed.
        /// </summary>
        bool FilteringActive { set; }
    }
}
